Skip to content

Match the indent for a single semicolon with the Puppet documentation #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 5, 2025
Merged

Match the indent for a single semicolon with the Puppet documentation #48

merged 2 commits into from
Aug 5, 2025

Conversation

@msalway
Copy link
Contributor

@msalway msalway commented Aug 4, 2025 •
edited
Loading

Change the handling of indent on the semicolon separator in resource statements so it matches the Puppet documentation example:
https://www.puppet.com/docs/puppet/7/lang_resources#resource-declaration-default-attributes

Fixes #19

Example from Puppet docs:

file {
  default:
    ensure => file,
    owner  => "root",
    group  => "wheel",
    mode   => "0600",
  ;
  ['ssh_host_dsa_key', 'ssh_host_key', 'ssh_host_rsa_key']:
    # use all defaults
  ;
  ['ssh_config', 'ssh_host_dsa_key.pub', 'ssh_host_key.pub', 'ssh_host_rsa_key.pub', 'sshd_config']:
    # override mode
    mode => "0644",
  ;
}

Currently the plugin expects this to be indented like this:

file {
  default:
    ensure => file,
    owner  => "root",
    group  => "wheel",
    mode   => "0600",
    ;
  ['ssh_host_dsa_key', 'ssh_host_key', 'ssh_host_rsa_key']:
    # use all defaults
    ;
  ['ssh_config', 'ssh_host_dsa_key.pub', 'ssh_host_key.pub', 'ssh_host_rsa_key.pub', 'sshd_config']:
    # override mode
    mode => "0644",
    ;
}

@msalway msalway mentioned this pull request Aug 4, 2025
Closed
@alexjfisher
Copy link
Member

alexjfisher commented Aug 5, 2025

The should indent for semi-colons not indented enough is wrong.

file {
  default:
    ensure => file,
    owner  => "root",
    group  => "wheel",
    mode   => "0600",
;
}
W: [strict_indent] indent should be 4 chars and is 0

It should be wanting 2 chars, not 4.

@alexjfisher
Copy link
Member

alexjfisher commented Aug 5, 2025

More tests you can pull in in 93b09f5

@msalway
Copy link
Contributor Author

msalway commented Aug 5, 2025 •
edited
Loading

Fixed bug with incorrect indent when fixing semicolon at start of line and added @alexjfisher's tests.

@alexjfisher @msalway
Add more tests for resource semi-colons
2cfe3a6 
Replaces existing fail cases
alexjfisher
alexjfisher reviewed Aug 5, 2025
View reviewed changes
spec/puppet-lint/plugins/check_strict_indent_spec.rb
@@ -1,4 +1,7 @@
require 'spec_helper'
# rubocop:disable Lint/RedundantRequireStatement
require 'pp'
Copy link
Member

@alexjfisher alexjfisher Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See puppetlabs/puppet-lint#247

@alexjfisher alexjfisher merged commit f0f1240 into voxpupuli:main Aug 5, 2025
6 checks passed
@msalway msalway mentioned this pull request Aug 6, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alexjfisher alexjfisher alexjfisher approved these changes

Assignees

No one assigned

Labels

backwards-incompatible

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update indent behaviour when semicolon is on a separate line

2 participants

@msalway @alexjfisher